docs: update docs and readme #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0xyaco
reviewed
Aug 30, 2024
apps/api/README.md
Outdated
Comment on lines
35
to
48
| - (optional) `PORT` on which API is made available. By default is port 3000 | ||
| - (optional) `ENVIRONMENT` which environment we are using ( 'mainnet' | 'testnet' | 'local'). By default is 'mainnet' | ||
| - `BRIDGE_HUB_ADDRESS` | ||
| - `SHARED_BRIDGE_ADDRESS` | ||
| - `STATE_MANAGER_ADDRESSES` CSV list of State managers addresses | ||
| - `L1_RPC_URLS` as CSV list of RPC URLs. For example, `https://eth.llamarpc.com,https://rpc.flashbots.net/fast`. You can check [Chainlist](https://chainlist.org/) for a list of public RPCs | ||
| - (optional) `PRICING_SOURCE` which pricing source to use ('dummy' | 'coingecko'). By default is dummy | ||
| - (optional) `DUMMY_PRICE` for dummy pricing source. Default is undefined | ||
| - (required if 'coingecko' is selected)`COINGECKO_API_KEY`, `COINGECKO_BASE_URL` and `COINGECKO_API_KEY` depending on your API plan. You can get an API Key creating an account on [Coingecko's site](https://www.coingecko.com/en/api) | ||
| - `METADATA_SOURCE` which metadata source to use ('github' | 'local' | 'static') | ||
| - (required if METADATA_SOURCE is 'github') `METADATA_TOKEN_URL` Metadata tokens URL | ||
| - (required if METADATA_SOURCE is 'github') `METADATA_CHAIN_URL` Metadata chains URL | ||
| - (required if METADATA_SOURCE is 'local') `METADATA_TOKEN_JSON_PATH` Metadata tokens JSON file path (see examples on `packages/metadata`) | ||
| - (required if METADATA_SOURCE is 'local') `METADATA_CHAIN_JSON_PATH` Metadata chain JSON file path (see examples on `packages/metadata`) |
There was a problem hiding this comment.
This is going the extra extra mile but, what do you think about using a Markdown table for this part? You can use this tool to generate your tables in an easier way
Eg
| Name | Description | Default | Notes |
|---|---|---|---|
| PORT | Port on which API is made available. | "3000" | |
| ENVIRONMENT | Environment used ('mainnet' | 'testnet' | 'local') | "mainnet" | |
| BRIDGE_HUB_ADDRESS | |||
| ... |
packages/pricing/README.md
Outdated
|
|
||
| 1. To create a new provider, create it inside [`providers`](./src/providers/) folder and implement the [`IPricingProvider`](./src/interfaces/pricing.interface.ts) interface. | ||
|
|
||
| > Note 1: is provider implementation responsibility to map token addresses to their internal id if needed. |
There was a problem hiding this comment.
It took me some seconds to understand this phrase at first, wdyt about these small changes?
Suggested change
| > Note 1: is provider implementation responsibility to map token addresses to their internal id if needed. | |
| > Note 1: it is the provider's responsibility to map token addresses to their internal id if needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤖 Linear
Closes ZKS-150
Description
Add docs and README files for packages